fix: add ADMIN_PUBLIC_KEYS to .env.example (fixes #4) - #16
Closed
presidojay1 wants to merge 1 commit into
Closed
Conversation
…rantFoxin#4) - Add ADMIN_PUBLIC_KEYS environment variable to .env.example - Include comprehensive documentation explaining usage - Add startup warning when ADMIN_PUBLIC_KEYS is not set - Prevents admin routes from returning 503 on fresh installs Closes grantFoxin#4
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #4 - Adds missing
ADMIN_PUBLIC_KEYSenvironment variable to.env.examplewith comprehensive documentation and startup warning.Problem
Fresh installs of SentientFi experience mysterious 503 errors on admin routes because
ADMIN_PUBLIC_KEYSis not documented in.env.example. Developers have no way to know:Changes Made
1. Updated
backend/.env.exampleADMIN_PUBLIC_KEYSwith clear documentation2. Updated
backend/src/index.tsADMIN_PUBLIC_KEYSis not setAdmin Routes Protected
The following routes require
ADMIN_PUBLIC_KEYSconfiguration:POST /api/auto-rebalancer/startPOST /api/auto-rebalancer/stopPOST /api/auto-rebalancer/force-checkGET /api/auto-rebalancer/historyPOST /api/rebalance/history/sync-onchainTesting
Before Fix
After Fix
Closes #4
Impact
Files Changed
backend/.env.example- Added ADMIN_PUBLIC_KEYS documentationbackend/src/index.ts- Added startup warningBreaking Changes
None - All changes are backward compatible and purely additive.
Checklist